Add --site-path filter to wp site list to avoid conflict with global --path#595
Open
Add --site-path filter to wp site list to avoid conflict with global --path#595
--site-path filter to wp site list to avoid conflict with global --path#595Conversation
Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix filtering by path in wp site list command
Add Mar 15, 2026
--site-path filter to wp site list to avoid conflict with global --path
swissspidy
reviewed
Mar 15, 2026
Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR resolves a long-standing usability issue in wp site list where filtering by the path field is effectively blocked by WP-CLI’s global --path parameter in non-strict args mode, by introducing a non-conflicting --site-path option.
Changes:
- Document the
--pathglobal-arg conflict and add a new--site-path=<path>option to enable reliable path-based filtering. - Implement
--site-pathhandling by mapping it to thepathcolumn filter. - Add a Behat scenario validating
--site-pathfiltering behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/Site_Command.php |
Adds --site-path option documentation and maps it to the path filter in wp site list. |
features/site.feature |
Adds an acceptance test scenario to ensure --site-path filters the site list correctly. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+1053
to
+1055
| if ( isset( $assoc_args['site-path'] ) ) { | ||
| $where['path'] = $assoc_args['site-path']; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
wp site listdocumentspathas a filterable field, but--pathis a global WP-CLI parameter (WordPress install directory), so it's silently consumed before reaching the command in normal usage — making path-based filtering impossible without strict args mode.Changes
src/Site_Command.php: Keepspathin the generic$site_colsauto-mapping loop (so--pathcontinues to work as a field filter whenWP_CLI_STRICT_ARGS_MODE=1is set), and adds explicit handling for--site-path=<path>, which maps to thepathcolumn inwp_blogs.--site-pathand notes that--pathconflicts with the global parameter in normal usage, recommending--site-pathinstead.features/site.feature: Adds a Behat scenario asserting--site-pathcorrectly filters results.Usage
Original prompt
wp site listto filter sites by path #285💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.